/*
    SDL - Simple DirectMedia Layer
    Partial implementation of SDL library (originally written by
    Sam Lantinga <slouken@libsdl.org>) for the particular purpose to support
    Prequengine (http://code.google.com/p/prequengine/) on BlackBerry(tm)
    tablets and smartphones.

    Copyright (C) 2013  xlamsp

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License along
    with this program; if not, write to the Free Software Foundation, Inc.,
    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

    xlamsp@gmail.com
*/


#ifndef SDL_CDROM_H_
#define SDL_CDROM_H_

#include "SDL_stdinc.h"


/** The maximum number of CD-ROM tracks on a disk */
#define SDL_MAX_TRACKS  99


/** The possible states which a CD-ROM drive can be in. */
typedef enum
{
    CD_TRAYEMPTY,
    CD_STOPPED,
    CD_PLAYING,
    CD_PAUSED,
    CD_ERROR = -1
} CDstatus;

/** Given a status, returns true if there's a disk in the drive */
#define CD_INDRIVE(status)  ((int)(status) > 0)

typedef struct SDL_CDtrack
{
    Uint8 id;           /**< Track number */
    Uint8 type;         /**< Data or audio track */
    Uint16 unused;
    Uint32 length;      /**< Length, in frames, of this track */
    Uint32 offset;      /**< Offset, in frames, from start of disk */
} SDL_CDtrack;

/** This structure is only current as of the last call to SDL_CDStatus() */
typedef struct SDL_CD
{
    int id;             /**< Private drive identifier */
    CDstatus status;    /**< Current drive status */

    /** The rest of this structure is only valid if there's a CD in drive */
    /*@{*/
    int numtracks;      /**< Number of tracks on disk */
    int cur_track;      /**< Current track position */
    int cur_frame;      /**< Current frame offset within current track */
    SDL_CDtrack track[SDL_MAX_TRACKS + 1];
    /*@}*/
} SDL_CD;


/**
 *  Returns the number of CD-ROM drives on the system, or -1 if
 *  SDL_Init() has not been called with the SDL_INIT_CDROM flag.
 */
extern int SDL_CDNumDrives(void);

/**
 *  Returns a human-readable, system-dependent identifier for the CD-ROM.
 *  Example:
 *   - "/dev/cdrom"
 *   - "E:"
 *   - "/dev/disk/ide/1/master"
 */
extern const char * SDL_CDName(int drive);

/**
 *  Opens a CD-ROM drive for access.  It returns a drive handle on success,
 *  or NULL if the drive was invalid or busy.  This newly opened CD-ROM
 *  becomes the default CD used when other CD functions are passed a NULL
 *  CD-ROM handle.
 *  Drives are numbered starting with 0.  Drive 0 is the system default CD-ROM.
 */
extern SDL_CD * SDL_CDOpen(int drive);

/**
 *  This function returns the current status of the given drive.
 *  If the drive has a CD in it, the table of contents of the CD and current
 *  play position of the CD will be stored in the SDL_CD structure.
 */
extern CDstatus SDL_CDStatus(SDL_CD *cdrom);

/**
 *  Play the given CD starting at 'start_track' and 'start_frame' for 'ntracks'
 *  tracks and 'nframes' frames.  If both 'ntrack' and 'nframe' are 0, play
 *  until the end of the CD.  This function will skip data tracks.
 *  This function should only be called after calling SDL_CDStatus() to
 *  get track information about the CD.
 *  For example:
 *      @code
 *	// Play entire CD:
 *	if ( CD_INDRIVE(SDL_CDStatus(cdrom)) )
 *		SDL_CDPlayTracks(cdrom, 0, 0, 0, 0);
 *	// Play last track:
 *	if ( CD_INDRIVE(SDL_CDStatus(cdrom)) ) {
 *		SDL_CDPlayTracks(cdrom, cdrom->numtracks-1, 0, 0, 0);
 *	}
 *	// Play first and second track and 10 seconds of third track:
 *	if ( CD_INDRIVE(SDL_CDStatus(cdrom)) )
 *		SDL_CDPlayTracks(cdrom, 0, 0, 2, 10);
 *      @endcode
 *
 *  @return This function returns 0, or -1 if there was an error.
 */
extern int SDL_CDPlayTracks(SDL_CD *cdrom, int start_track, int start_frame, int ntracks,
        int nframes);

/** Stop play
 *  @return returns 0, or -1 on error
 */
extern int SDL_CDStop(SDL_CD *cdrom);

/** Closes the handle for the CD-ROM drive */
extern void SDL_CDClose(SDL_CD *cdrom);


#endif /* SDL_CDROM_H_ */

